<?php
//
//  VictoryCMS - Content managment system and framework.
//  Copyright (C) 2009  Lewis Gunsch
//
//  This file is part of VictoryCMS.
//  
//  VictoryCMS is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  VictoryCMS is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//  
//  You should have received a copy of the GNU General Public License
//  along with VictoryCMS.  If not, see <http://www.gnu.org/licenses/>.

/**
 * VictoryCMS - DBManager
 * 
 * @license http://www.gnu.org/licenses/gpl.html
 * @author Lewis Gunsch
 * @filesource
 * @package DBAbstraction
 */

/**
 * 
 * This interface is used by model object which need to use the database.
 * 
 * @package DBAbstraction
 * 
 * @todo Needs documentation finished
 */
interface DBManager {
	
	/** Creates and initializes an objects database table.*/
	function setUpDb();
	
	/** Updates an objects database table. */
	function updateDb();
	
	/** Drops tables and rows associated with this object. */
	function tearDownDb();
	
	/** 
	 * Checks whether a database table exits and is valid.
	 * @return boolean True if table exists and is valid.
	 */
	function isValid();
}

?>